home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / calend1.zip / MANUAL.DOC < prev    next >
Text File  |  1992-11-19  |  8KB  |  199 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                  CalenDoor - Calendar of Events Door
  8.      
  9.                     (c) 1992, Cove Communications
  10.      
  11.       A. Zip contents
  12.          1. caldoor.exe - CalenDoor program
  13.          2. cal.* - calendar display file and key files
  14.          3. items.* - calendar items file and key files
  15.          4. control.dat - configuration information
  16.          5. memo.* - calendar item text
  17.          6. users.* - users file
  18.          7. register.doc
  19.          8. license.doc
  20.          9. manual.doc
  21.         10. sample DOOR.SYS file
  22.             a) You may want to use this for testing instead of your own
  23.                DOOR.SYS if you can't get CalenDoor to run on your system.
  24.                It's not needed for local logon. Make sure you change the
  25.                port, baud, and any other settings to those your system
  26.                expects first.
  27.       B. Operation
  28.          1. Who can use CalenDoor
  29.             a) your callers DO NOT REQUIRE FULL ANSI capability to use the
  30.                CalenDoor. The first time anyone uses the door they are
  31.                asked a series of questions which determine the exact
  32.                capabilities of the terminal emulation they are using. All a
  33.                user really needs is to interpret ANSI cursor positioning
  34.                codes properly. We have successfully logged on with an
  35.                ancient 512k Macintosh using MacTerm. It wasn't pretty, but
  36.                it worked. If necessary, the CalenDoor will translate colors
  37.                and line draw characters, so you may want to let your
  38.                non-ansi callers take a crack at the door too. Monochromers
  39.                can still change their colors, though they'll only have a
  40.                choice of normal, reverse video, blink and in some cases
  41.                underline.
  42.          2. installing CalenDoor
  43.             a) Wherever you choose to install CalenDoor, you must make sure
  44.                that you make that directory the current directory before
  45.                you run the program. CalenDoor will only look in the current
  46.                directory for its own data files and for your DOOR.SYS file.
  47.                door.sys and all CalenDoor program and data files must be in
  48.                the current directory. If you install CalenDoor in a
  49.                different direct (i.e. CalenDoor won't go looking for the
  50.                data files, and at present you can't specify)
  51.             b) CONFIG.SYS
  52.                1. you will need a FILES=nn statement in your config.sys where
  53.                   nn is at least 25 for every copy of CalenDoor you have
  54.                   running on that machine. You should set this number a little
  55.                   higher than you need to prevent a "too many files open"
  56.                   error message. The memory penalty for the FILES= statement
  57.                   is quite low.
  58.             c) Available Memory
  59.                1. you will need a minimum of about 450k free to run CalenDoor.
  60.                   This means your BBS program will almost certainly have to
  61.                   shell to DOS.
  62.  
  63.                                         1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.          3. Registering CalenDoor
  74.             a) see Registering under the Sysop menu, below.
  75.          4. limitations of unregistered version
  76.             a) can't generate bulletins
  77.             b) can't schedule repeating events
  78.             c) can't schedule anything more than two weeks into the future
  79.          5. bulletins
  80.             a) new items - newcal.ans/asc
  81.                1. bulletins with any items added by the user are automatically
  82.                   generated when the user leaves the door IF the program is
  83.                   registered. The files are NEWCAL.ANS and NEWCAL.ASC.
  84.             b) today's/tomorrow/s items - todaycal, tmrwcal
  85.                1. if the program is registered, you can generate a bulletin of
  86.                   today's events (the program will work from the system date)
  87.                   by running the command CALDOOR /TODAYBULL. The program will
  88.                   return to the dos prompt when it has generated the bulletin.
  89.                   You may want to do this as part of your system's regular
  90.                   nightly maintenance. To generate a bulletin of tomorrow's
  91.                   events, use the command CALDOOR /TOMORROWBULL. CalenDoor
  92.                   does not mess with the serial port at all during this
  93.                   operation, so you can run it while you are on-line, if
  94.                   that's what blows your hair back. The bulletin files
  95.                   generated are TODAYCAL.ASC/ANS and TMRWCAL.ASC/ANS. They're
  96.                   nothing fancy (yet).
  97.          6. running in local mode
  98.             a) use the command CALDOOR /LOCAL
  99.             b) CalenDoor_Sysop is the local user
  100.             c) you have full add/delete access, no time limit
  101.             d) local mode key differences
  102.                1. when editing the main text for an item, you can use
  103.                   ctrl-end, ctrl-home to delete the remaining part or all of
  104.                   the line, respectively. These keys do not work in on-line
  105.                   mode.
  106.          7. the calendar screen
  107.             a) functions the same in local mode as on-line
  108.             b) use the (T)oday command to return from wherever you are in
  109.                the calendar to today's date.
  110.             c) press Enter to see/add items for a given day
  111.                1. adding/changing/deleting items
  112.                   a) users can only change or delete their own items
  113.                   b) times are entered in 24 hour format (this will probably be
  114.                      changed in a later version).
  115.                2. (V)iewing an item
  116.                   a) The instruction (F)orward or the instruction (B)ackward will
  117.                      appear at the bottom of the window if the item is too long
  118.                      for one screenful
  119.          8. changing colors
  120.             a) each user has his/her own color settings
  121.             b) the screen which shows sample color settings is generic and
  122.                will be/is used in other doors also.
  123.          9. sysop menu
  124.             a) verify calendar
  125.                1. although it's unlikely you'll need to do this, you can
  126.                   verify that the data in the items file is properly
  127.                   represented in the calendar screen. A holdover from
  128.  
  129.                                         2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                   debugging, this could be required if you had a session
  140.                   interrupted by power failure or other event before the
  141.                   calendar file could be updated.
  142.             b) purge old data
  143.                1. enter the date you want to purge the file up to. The
  144.                   calendar is automatically verified after this operation.
  145.             c) Registration
  146.                1. Pay your registration fee to Cove Communications, and supply
  147.                   the exact name of your BBS as you want it to be displayed
  148.                   on-screen. We will give you your registration number.
  149.                2. sign on in local mode (CALDOOR /LOCAL) and press Alt-S from
  150.                   the calendar screen for the sysop menu. Choose Registration,
  151.                   and follow the instructions on-screen.
  152.             d) events scheduling
  153.                1. use for regular items - schedule either weekly or daily
  154.                   events by entering the data and specifying a date range
  155.                2. after the events have been scheduled, you can
  156.                   add/change/delete these items the same way you
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                         3
  196.  
  197.  
  198.  
  199.